package com.alibaba.algo.components.yapi.annotations;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @Description: 实体类属性字段注解
 * @author: malin
 * @date: 2020-11-20 15:51:35
 */
@Target({ ElementType.PARAMETER, ElementType.METHOD, ElementType.FIELD })
@Retention(RetentionPolicy.RUNTIME)
public @interface ApiModelProperty {

	/** 属性描述 */
	String value() default "";

	/** 属性名称 如果为空则反射读取 */
	String name() default "";

	/** 是否必须 */
	boolean required() default false;

	/** 属性类型 如果为空则反射读取该属性的类型 */
	String dataType() default "";

	/** mock数据 */
	String mock() default "";

	/** 参数示例 */
	String example() default "";
}
